create-turbo

开始使用 Turborepo 最简单的方法是使用 create-turbo。使用此 CLI 工具可以快速开始构建一个新的 monorepo,所有配置都已为你设置好。

终端
pnpm dlx create-turbo@latest

从示例开始

社区整理了一系列示例,展示如何将常用工具和库与 Turborepo 一起使用。要使用其中一个示例引导你的 monorepo,请使用 --example 标志

终端
pnpm dlx create-turbo@latest --example [example-name]

使用以下任何示例名称

核心维护的示例

以下示例由 Turborepo 核心团队维护。依赖项会尽可能保持最新,并且接受并处理这些示例的 GitHub Issues。

名称描述
基础包含两个 Next.js 应用的基础 monorepo 示例
工具箱多个框架,包括前端和后端
非 monorepo使用 Turborepo 的独立应用
Shell 命令几乎为空的 Turborepo - 用于为 GitHub Issues 创建复现非常有用
SvelteKit包含多个 SvelteKit 应用并共享 UI 库的 Monorepo
TailwindCSS包含多个 Next.js 应用并共享使用 TailwindCSS 构建的 UI 库的 Monorepo

社区维护的示例

社区整理了一系列示例,展示如何将常用工具和库与 Turborepo 一起使用。要使用其中一个示例引导你的 monorepo,请使用 --example 标志

名称描述
设计系统通过在多个应用之间共享设计系统,统一你网站的外观和感觉
Angular用于学习基础知识的最小 Turborepo 示例
Yarn Berry使用 Yarn Berry (Yarn 3) 的 Monorepo 示例
Changesets配置为通过 Changesets 发布包
Docker包含 Express API 和 Next.js 应用的 Monorepo,使用 Docker 部署并利用 turbo prune
Gatsby包含 Gatsby.js 和 Next.js 应用并共享 UI 库的 Monorepo
Nest.js包含 Nest.js 的 Monorepo
npm workspaces使用 NPM workspaces 的 Monorepo 示例
Prisma包含完全配置了 Prisma 的 Next.js 应用的 Monorepo
React Native包含共享 UI 库的简单 React Native & Next.js monorepo
Rollup包含单个 Next.js 应用并共享使用 Rollup 打包的 UI 库的 Monorepo
Solid.js包含 SolidJS 应用的 Monorepo 示例
typeorm包含完全配置了 typeorm 的 Next.js 应用的 Monorepo
Vite包含多个使用 Vite 打包的 Vanilla JS 应用并共享 UI 库的 Monorepo
Vite + React包含 Vite 和 React 的 Monorepo 示例
Vitest包含使用 Vitest 进行测试的 Monorepo 示例
Vue/Nuxt包含 Vue 和 Nuxt 并共享 UI 库的 Monorepo
Yarn使用 Yarn workspaces 的 Monorepo 示例

使用社区示例

你还可以通过使用 GitHub URL 来使用自定义启动器或示例。这对于使用你自己的自定义启动器或来自社区的示例非常有用。

终端
pnpm dlx create-turbo@latest --example [github-url]

选项

终端
-m, --package-manager to use (choices: "npm", "yarn", "pnpm", "bun")

--skip-install: Do not run a package manager install after creating the project (Default: false)

--skip-transforms: Do not run any code transformation after creating the project (Default: false)

--turbo-version <version>: Use a specific version of turbo (default: latest)

-e, --example [name]|[github-url]: An example to bootstrap the app with. You can use an example name from the official Turborepo repo or a GitHub URL. The URL can use any branch and/or subdirectory

-p, --example-path <path-to-example>: In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: --example-path foo/bar

-v, --version:  Output the current version

-h, --help: Display help for command